home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / edit / hex32.zip / README.TXT < prev   
Text File  |  1994-12-14  |  13KB  |  344 lines
  1.  ╔════════════════════════════════════════════════════════════════════╗
  2.  ║               Fixes and Enhancements from 2.0 to 3.2               ║
  3.  ╚════════════════════════════════════════════════════════════════════╝
  4.  
  5.     Enhancements:
  6.     
  7.     -Allows dumping to a file for printing
  8.     -Allows mapping of keys (described below)    
  9.     -File manipulation goodies (change file attributes at a click...)
  10.     (see F1 in both file selection and editing mode)
  11.  
  12.     Fixes:
  13.  
  14.     -Problem with Alt-C leaving garbage window behind
  15.     -F7 button not working properly
  16.     -Mapping of F2 key making mouse select impossible
  17.     -Minor Aesthetic stuff
  18.  
  19.     Neat Stuff:
  20.  
  21.     -Mouse interface
  22.     -Allows searching:
  23.  
  24.         -Multiple HEX values (ie. 'FF 23 7E')
  25.         -Hex or Text searches
  26.         -Count occurences of Hex or Text values
  27.         -Search again 
  28.  
  29.     -Allows inserting and deleting 
  30.     -Pop-up windows
  31.     -Configuration:
  32.  
  33.         -Colors
  34.         -Key mapping
  35.         -Screen saver timeout,memory to use...
  36.  
  37.     -Edits files of any size
  38.     -Change file attributes at a click
  39.     -Point and click style file selection
  40.     -Allows viewing with alternate editor
  41.     -Screen Saver 
  42.  
  43.     
  44.  ╔════════════════════════════════════════════════════════════════════╗
  45.  ║                             Index                                  ║
  46.  ╚════════════════════════════════════════════════════════════════════╝
  47.  
  48.     1.    Command line
  49.     2.    Overview of files
  50.     3.    Hex.cfg file
  51.     4.    Environment variables
  52.     5.    Mapping keys
  53.     6.    Additional comments
  54.  
  55.  ╔════════════════════════════════════════════════════════════════════╗
  56.  ║                    1.  The Command Line                            ║
  57.  ╚════════════════════════════════════════════════════════════════════╝
  58.  
  59.  
  60.         Usage: HEX [-v] [-t:temp_file] [-l:lines] [filename] \n");
  61.  
  62.         -v      View mode (read-only). Speed is greatly increased.      
  63.         -t:     Rename temp file. Temp files are usually created 
  64.                 by using the current hour,minutes,seconds and 
  65.                 hundredth of seconds to prevent multiple temp files
  66.                 from having the same name should someone decide
  67.                 to open more than one session of Hex.
  68.  
  69.         -l:     Same as HEXLINES variable. If specified here, it 
  70.                 will override the ENVIRONMENT variable and config
  71.                 settings.
  72.  
  73.        filename    This can be a full path, relative path. Using
  74.         the format *.c for example would list all of the
  75.         files with a .c extension. One may be picked from
  76.         there.
  77.             
  78.    No Filename  This will put you into the file selection mode.
  79.  
  80.  
  81.  ╔════════════════════════════════════════════════════════════════════╗
  82.  ║                    2. Quick file Overview                          ║
  83.  ╚════════════════════════════════════════════════════════════════════╝
  84.  
  85.         Hex.exe:  Main executable. Should be in path.
  86.  
  87.         Hex.cfg:  Configuration options. It is first searched
  88.                   for in the path pointed to by HEXPATH. If it
  89.                   is not there, it is searched for in the 
  90.                   directory where the hex.exe is found. If it        
  91.                   is found in neither, the defaults are used.
  92.  
  93.         Hex.hlp:  Contains information for help screens. It is
  94.                   searched for in the same way as hex.cfg. Do
  95.                   not touch this file! Any change will seriously
  96.                   screw up the help menus.
  97.  
  98.  
  99.  ╔════════════════════════════════════════════════════════════════════╗
  100.  ║                     3. The HEX.CFG File                            ║
  101.  ╚════════════════════════════════════════════════════════════════════╝
  102.  
  103.  
  104.  
  105.         The Hex.cfg file contains settings which are 
  106.         initialized before the program begins. These
  107.         settings can usually be set using environment
  108.         variables or from within the program.
  109.  
  110.         Entries are of the form KEYWORD=VALUE
  111.  
  112.  
  113.         The following KEYWORDS are currently accepted
  114.         and are shown with their defaults in this sample
  115.         Hex.cfg file.
  116.  
  117.      ┌──────────────────────────────────────────────────┐
  118.      │       Active Cursor=BLACK,GREEN,BLINK;           │
  119.      │       Inactive Cursor=GREY,GREEN;                │
  120.      │       Marked Text=WHITE,RED;                     │
  121.      │       Normal Text=CYAN,BLACK;                    │                       
  122.      │       Offsets=GREEN,BLACK;                       │
  123.      │       Titles=GREEN,BLACK;                        │
  124.      │       Title values=WHITE,BLACK;                  │
  125.      │                                                  │
  126.      │       AUTO DELETE=NO;                            │
  127.      │       BRKOUT=NO;                                 │
  128.      │       HEXBIG=150000;                             │
  129.      │       HEXMEM=50000;                              │
  130.      │       LINES=25;                                  │
  131.      │       OVERWRITE=YES;                             │
  132.      │       PAUSE TIME=0;                              │
  133.      │       SCRTIME=300;                               │
  134.      │       TEMP=c:\temp;                              │
  135.      └──────────────────────────────────────────────────┘
  136.                                                                       
  137.         The AUTO DELETE variable indicates whether
  138.         the user wishes to be able to delete files
  139.         without prompting. If AUTO DELETE=YES then
  140.         the user can use the Alt-D combination to
  141.         delete files without prompting. This is 
  142.         useful when one know that they will be deleting
  143.         many files. 
  144.  
  145.         The BRKOUT variable indicates what action the
  146.         control-break key will take when it is hit.
  147.         If BRKOUT=YES then then the program will break
  148.         out of the program upon receiving the break
  149.         signal. This is useful for debugging.
  150.  
  151.         The OVERWRITE variable indicates where hex will
  152.     start in Insert mode or Overwrite mode.
  153.  
  154.     The HEXBIG (or BIG FILE) variable controls how
  155.         big a file must be before it is considered a 'big'
  156.         file. If a file of this size or bigger is loaded,
  157.         the user will be asked if they'd like to load the
  158.         file as read-only. If, for example, someone 
  159.         wanted to peek at part of a 4MEG file, they
  160.         would normally have to wait quite a while for
  161.         the temp file to be created. If it was caught
  162.         by the HEXBIG variable, it would save the user
  163.         a lot of time! 
  164.  
  165.         The HEXMEM (or MEMORY or BUFFER) variable
  166.         sets the maximum amount of memory that is set
  167.         aside for information storage. The larger the
  168.         number is, the slower text manipulation will be
  169.         but disk access will be lessened. You need a
  170.         minumum of 5000 bytes due to overhead.
  171.  
  172.         The LINES variable controls what video mode
  173.         you are in. Values of 25, 43 or 50 are the
  174.         recommended ones, but any value can be used.
  175.  
  176.         The PAUSE TIME variable controls the number of
  177.         milli-seconds information windows remain on 
  178.         the screen. A value of one or two thousands
  179.         might be useful to a new user, where most users
  180.         will have it set to 0, to make things quicker.
  181.  
  182.         The SCRTIME variable holds the number of seconds
  183.         HEX waits until the screen saver kicks in.
  184.         
  185.         The TEMP variable allows you to set the directory
  186.         in which tempfiles will be written. This directory
  187.         must be able to hold at least the size of the file
  188.         you are editing. (RAM drives are great for this!)
  189.                 
  190.      ┌──────────────────────────────────────────────────┐
  191.      │                                                  │
  192.      │  The following are the colors that may be used   │
  193.      │                                                  │
  194.      │  "BLACK"                                         │              
  195.      │  "BLUE"                                          │
  196.      │  "GREEN"                                         │
  197.      │  "CYAN"                                          │
  198.      │  "RED"                                           │
  199.      │  "MAGENTA"                                       │
  200.      │  "BROWN"                                         │
  201.      │  "WHITE"                                         │
  202.      │  "GREY"                                          │
  203.      │  "BRIGHT BLUE"                                   │
  204.      │  "BRIGHT GREEN"                                  │
  205.      │  "BRIGHT CYAN"                                   │
  206.      │  "BRIGHT RED"                                    │
  207.      │  "BRIGHT MAGENTA"                                │
  208.      │  "YELLOW"                                        │
  209.      │  "BRIGHT WHITE"                                  │
  210.      │                                                  │
  211.      └──────────────────────────────────────────────────┘
  212.         
  213.  ╔════════════════════════════════════════════════════════════════════╗
  214.  ║                 4. Environment Variables                           ║
  215.  ╚════════════════════════════════════════════════════════════════════╝
  216.  
  217.  
  218.         BRKOUT          ie. set BRKOUT=YES
  219.  
  220.         HEXLINES        ie. set HEXLINES=25
  221.  
  222.         HEXBIG          ie. set HEXBIG=100000
  223.  
  224.         HEXMEM          ie. set HEXMEM=50000    
  225.  
  226.         HEXPATH         ie. set HEXPATH=c:\hex
  227.  
  228.            This points to the directory in which
  229.            the hex.cfg is found. If it is not set
  230.            the file will be looked for in the
  231.            directory from which hex.exe was run.If                           
  232.            it is not found there, the default values
  233.            are used. This is also the directory used
  234.            to find the hex.hlp file. 
  235.  
  236.         
  237.         TEMP            ie. set TEMP=c:\tmp
  238.  
  239.            If this is not set, the current directory
  240.            will be used. This may be a problem if
  241.            you are sitting in a directory where you
  242.                   do not have write permissions. Make sure
  243.            there is enough room in this directory
  244.            for a swap file the size of the file you
  245.            are editing (unless in read-only mode).
  246.  
  247.  
  248.  ╔════════════════════════════════════════════════════════════════════╗
  249.  ║                         5. Mapping Keys                            ║
  250.  ╚════════════════════════════════════════════════════════════════════╝
  251.  
  252.     Now, you may map keys! It is fairly basic, but should get
  253.     the job done. For example, to save a file, the default is
  254.     Alt-W. If you use an editor that uses ALT-S to save then you
  255.     would enter the line "MAP=SAVE,31" somewhere in the hex.cfg file. 
  256.     (The mappings will not affect the file selector routine. ie when 
  257.     hex is typed without parameters)
  258.  
  259.     Remember that each action can only have one key. So, when mapping,
  260.     try to map to a key which does not already have a function. If it
  261.     does, then you will want to re-map that one as well.
  262.  
  263.  
  264.      The format of Mapping is "MAP=<Action>,<New_Key_For_It>"
  265.  
  266.      The following are the defaults:    
  267.  
  268.      MAP=HELP,59                 F1      
  269.      MAP=MARK,60                 F2      
  270.      MAP=INFO,61                 F3      
  271.      MAP=ABORTSELECT,62          F4      
  272.      MAP=SEARCH,63               F5      
  273.      MAP=COLORS,64               F6      
  274.      MAP=LOCKTOTAL,65            F7      
  275.      MAP=NUMBEROFLINES,66        F8      
  276.      MAP=PRINTTOFILE,67          F9      
  277.      MAP=SAVESELECTION,68        F10     
  278.      MAP=SAVETOCLIPBOARD,43       +   (This is only non-ALT,F key allowed)
  279.      MAP=ALTEDITOR,30            ALTA     
  280.      MAP=COUNTOCC,46             ALTC        
  281.      MAP=EDITNEWFILE,18          ALTE           
  282.      MAP=GOTOOFFSET,34           ALTG      
  283.      MAP=INSERTMODE,23           ALTI      
  284.      MAP=GOTOPAGE,25             ALTP        
  285.      MAP=SAVE,17                 ALTW              
  286.      MAP=EXIT_,45                ALTX           
  287.      MAP=SHELL,44                ALTZ        
  288.      MAP=SEARCHAGAIN,89       <SHIFT> F6   
  289.      MAP=INSERT,82             <INSERT>    
  290.  
  291.  
  292.     NOTE!!! Alt-X will always escape. (But you may map another
  293.         key to it such that it will as well)
  294.  
  295.                 Ascii_Codes
  296.  
  297.     
  298.            Function Keys:   F1-F10  59-68
  299.                     
  300.                     ie. F5 is 63
  301.                            
  302.            Shift Function Keys:  ^F1-^F10  84-93       
  303.                   
  304.                ie. Shift F5 is 88
  305.   
  306.   
  307.             
  308.                      Alt:  QWERTYUIO  16-25  
  309.                            ASDFGHJKL  30-38
  310.                            ZXCVBNM    44-50
  311.                               ^---------------
  312.                                              |
  313.                             ie. Alt-V is 47--|
  314.              
  315.  
  316.  
  317.  
  318.  ╔════════════════════════════════════════════════════════════════════╗
  319.  ║                       6. Additional Comments                       ║
  320.  ╚════════════════════════════════════════════════════════════════════╝
  321.  
  322.  
  323.  
  324.  
  325.                           GETTING HELP
  326.  
  327.    
  328.    It is recommended that you use the F1 option to get help in
  329.    both the file selection mode and file editor mode. Go through
  330.    all of the options available, learning the significance of all
  331.    of the different functions.
  332.  
  333.  
  334.                           HORSES MOUTH
  335.  
  336.  
  337.    If you have any other questions or requests for enhancements,
  338.    please do not hesitate to mail me at jgdurwar@uwaterloo.ca.
  339.  
  340.  
  341.  
  342.  
  343.    
  344.